Skip to content

add usage guide with practical examples#42

Open
rootdevss wants to merge 2 commits intoMaximumADHD:robloxfrom
rootdevss:usage-guide
Open

add usage guide with practical examples#42
rootdevss wants to merge 2 commits intoMaximumADHD:robloxfrom
rootdevss:usage-guide

Conversation

@rootdevss
Copy link
Copy Markdown

@rootdevss rootdevss commented Feb 10, 2026

hey, made a usage guide to help people who want to use the repo data but dont know where to start

the repo updates multiple times per week but lacks documentation on how to actually use the data in practice, so i created this guide with:

  • python code examples for parsing api dump and fvariables
  • real world use cases like detecting breaking changes and new apis
  • automation scripts with github actions and discord/telegram webhooks
  • explanation of how to interpret each file in the repo
  • best practices tips and version comparison methods

thought it would add a lot of value for the community who wants to extract insights from the automated data

@rootdevss rootdevss changed the title adiciona guia de uso com exemplos praticos add usage guide with practical examples Feb 10, 2026
@rootdevss
Copy link
Copy Markdown
Author

hey @MaximumADHD, this pr adds a practical usage guide for the repo data

saw that pr #27 added similar documentation to the readme and thought this would complement it nicely. the guide includes:

  • code examples for parsing the dumps
  • automation scripts for monitoring updates
  • real use cases the community might find helpful

lmk if you'd like any changes or if this fits the repo's direction

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant